feat(config): add doc-kit.config.mjs for webpack branding#42
Merged
avivkeller merged 2 commits intowebpack:mainfrom Mar 22, 2026
Merged
feat(config): add doc-kit.config.mjs for webpack branding#42avivkeller merged 2 commits intowebpack:mainfrom
avivkeller merged 2 commits intowebpack:mainfrom
Conversation
- Set repository to webpack/webpack (fixes GitHub links in navbar) - Set web.title to webpack (fixes product name in sidebar/navbar labels) - Disable jsx-ast editURL (generated docs have no hand-editable source) - Fix build-html script to auto-create out/ directory before generation Closes webpack#6
avivkeller
approved these changes
Mar 22, 2026
Member
avivkeller
left a comment
avivkeller
left a comment
There was a problem hiding this comment.
Thank you! I'll make the upstream changes needed for this
Comment on lines
+16
to
+18
| // Disable the "Edit this page" link — webpack API docs are generated from | ||
| // TypeScript types and don't have a corresponding hand-editable source file. | ||
| editURL: '', |
Member
There was a problem hiding this comment.
TODO(me): if editURL is not supplied, don't show it on doc-kit
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
doc-kit.config.mjsto configure@node-core/doc-kitwith webpack-specific settings, addressing #6.Changes:
global.repositorytowebpack/webpack— the GitHub link in the navbar now correctly points to the webpack repo instead ofnodejs/nodeweb.titletowebpack— the product name in sidebar version labels and navbar aria-labels now says "webpack" instead of "Node.js"jsx-ast.editURLto''— disables the "Edit this page" link since webpack API docs are generated from TypeScript types and have no hand-editable source filebuild-htmlscript to pass--config-file ./doc-kit.config.mjsand addsmkdir -p outso the output directory is created automatically (no moreENOENTon first run)Note: The
<title>tag in generated HTML still hardcodes "Node.js" — this is in@node-core/doc-kitsource and requires an upstream fix to make the product name configurable viaweb.title.Test plan
npm run build-htmlsucceeds without a pre-existingout/directoryhttps://github.com/webpack/webpacknodejs/node